\name{EstimateSpeciesRichness}
\alias{EstimateSpeciesRichness}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{ Estimate Simple Species Richness }
\description{
  This function estimates species richness (number of unique species seen for each site(station) and year.
  In the future this function will have additional options on how to group the estimates and possibly other ways to estimate species richness.
}
\usage{
EstimateSpeciesRichness(data = NULL, min.month = 3, max.month = 8, year = NULL, ...)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
  \item{data}{ a data.frame of the same form as the retrieved from \link{getPCdata}}
  \item{min.month}{ Minimum month for each year}
  \item{max.month}{ Maximum value for month each year  }
  \item{year}{ Numeric vector of years to include in analysis }
  \item{\dots}{ additional variables passed on to internal functions }
}
\details{
  Species richness is simply defined as the total number of
  species detected withi the monthly restrictions provided
  by the user.  Results are provided for each year separately.

}
\value{
A data frame with species richness by year and station}

\author{ Mark Herzog \email{mherzog@prbo.org}}

\seealso{ \code{\link{getPCdata}}, \code{\link{EstimateAbundance}} }
\examples{
##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--    or do  help(data=index)  for the standard data sets.

## The function is currently defined as
palo.data<-getPCdata(database='digir-ro',station="PALO") # load in the data from the BMDE database, filter for only the "PALO" station
(palo.SR<-EstimateSpeciesRichness(palo.data,min.month=3,max.month=7)) # generates a data.frame of by year species richness estimates
#       station_name
# year   Palomarin Grids
#  1997              41
#  1998              41
#  1999              42
#  2002              36
#  2003              55
#  2004              38
#  2005              36


}
% Add one or more standard keywords, see file 'KEYWORDS' in the
% R documentation directory.
\keyword{ datagen }
